Skip to content

Allow user to specify alternative server from config and enforce simvue.Run keyword arguments#913

Open
kzscisoft wants to merge 3 commits intodevfrom
feature/server-profiles
Open

Allow user to specify alternative server from config and enforce simvue.Run keyword arguments#913
kzscisoft wants to merge 3 commits intodevfrom
feature/server-profiles

Conversation

@kzscisoft
Copy link
Collaborator

@kzscisoft kzscisoft commented Jan 28, 2026 •
edited
Loading

Add Config Option for Alternative Profiles & Enforced Keyword Arguments for simvue.Run.

Issue: N/A

Python Version(s) Tested: 3.13

Operating System(s): Ubuntu 25.10

Documentation PR: Issue on Docs repo.

📝 Summary

  • Allows the user to specify multiple servers in their simvue.toml configuration file and specify which to use.
  • Enforces keyword arguments in simvue.Run.__init__ due to large number of arguments, this is to ensure the user is clear and absolute in their intention, i.e. due to multiple string arguments ("profile", "mode" etc.) this ensures mode isn't read as a profile.

🔄 Changes

simvue.toml:

[server]
url = "https://simvue.example.com"
token = "not-a-token"

[profiles.dev]
url = "https://simvue-dev.example.com"
token = "not-a-token"

SimvueConfiguration class:

SimvueConfiguration.fetch(mode="online", profile="dev")

simvue.Run class:

with simvue.Run(server_profile="dev") as run:
  ...

✔️ Checklist

  • Unit and integration tests passing.
  • Pre-commit hooks passing.
  • Quality checks passing.
  • Updated the documentation.

@kzscisoft kzscisoft added this to the Simvue Python API v2.3 milestone Jan 28, 2026
@kzscisoft kzscisoft added the enhancement New feature or request label Jan 28, 2026
@james-panayis
Copy link
Collaborator

james-panayis commented Jan 29, 2026

Technically, forcing keyword arguments in Run.__init__ is a breaking change, so should arguably be delayed until a major release. However, I suspect it's uncommon for anyone to pass any arguments to Run.__init__ at all, and when they do they're likely to already be using keyword arguments, so perhaps this is fine. Do we think it's worth immediately breaking this now instead of just deprecating positional arguments and then removing them in v3.0.0? I'm ambivalent.

james-panayis
james-panayis reviewed Jan 29, 2026
View reviewed changes
@james-panayis
Copy link
Collaborator

james-panayis commented Jan 29, 2026

Two comments. Otherwise, this will is a very convenient feature - it'll make things much easier for me, for example!

My only other thought is that maybe this should not be mentioned in the official docs. A normal user is very unlikely to ever interact with multiple Simvue servers, so this option is likely to confuse them. I think this is essentially a 'dev feature'.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wk9874 wk9874 Awaiting requested review from wk9874

@james-panayis james-panayis Awaiting requested review from james-panayis

Assignees

@james-panayis james-panayis

@wk9874 wk9874

Labels

enhancement New feature or request

Projects

None yet

Milestone

Simvue Python API v2.4

Development

Successfully merging this pull request may close these issues.

3 participants

@kzscisoft @james-panayis @wk9874